Pular para o conteúdo principal

Autenticação

Instruções sobre o processo de autenticação nas APIs da Delfinance.

Requisitos de segurança

Ambiente produtivo

Para consumir as APIs HTTP no ambiente produtivo, sua integração deve cumprir todos os requisitos abaixo:

1. Headers requeridos

Você deve enviar:

HeaderObrigatórioDescrição
x-delbank-api-keySimAutentica o cliente
x-delfinance-account-idSimIdentifica a conta acessada, e deve ser associada com a chave de API enviada

Observação: headers HTTP são case-insensitive, mas recomendamos manter exatamente os nomes acima por padronização.

Responsabilidades dos Headers

  • x-delbank-api-key

    • Autentica sua organização.
    • Determina se sua integração é autorizada à acessar a API.
  • x-delfinance-account-id

    • Identifica qual conta que a requisição está operando em.
    • Deve ser associada com deve ser associada com a chave de API enviada.

Se a chave de API (API Key) é valida mas não for autorizada para a conta especificada, a requisição será rejeitada.

2. mTLS (Mutual TLS)

O ambiente produtivo requer mTLS (TLS com certificado do cliente (client certificate)).

  • Você precisará informar o certificado de cliente válido e correspondente chave privada na sua stack (gateway, app, SDK, código-fonte, etc.).
  • Requisições sem um certificado de cliente válido serão rejeitadas.

3. Allowlist de IP (Static Egress IP)

O acesso em produção também exige a inclusão de IPs na allowlist de IPs.

  • Você deve fornecer antecipadamente seus endereços IP públicos fixos de saída (egress).
  • Apenas requisições originadas de IPs aprovados serão aceitas.
  • Solicitações provenientes de IPs que não estejam na lista de permissão serão rejeitadas.

É responsabilidade do cliente garantir que esses IPs:

  • Não mudem
  • Sejam utilizados exclusivamente para comunicação com a API
A aplicação da allowlist de IPs será obrigatória em produção a partir de fevereiro/2026.

Ambiente de Homologação (Sandbox)

No ambiente de homologação, requerimentos de segurança são simplificados:

  • x-delbank-api-key é obrigatório
  • x-delfinance-account-id é obrigatório
  • ❌ mTLS NÃO é obrigatório
  • ❌ Allowlist de IP NÃO é obrigatório
Sandbox é um ambiente feito apenas para desenvolvimento e testes de integração.

No Sandbox, os requisitos de mTLS e allowlist de IP não são necessários.

Para testes em Sandbox, uma das contas abaixo pode ser utilizada (com suas respectivas chaves de API):

Account IDChave de API
31712PJPyJ2xGmyB9oDHyNIUwNOt1dgpgolBwcE16ybaKD5rYEc8ujLtarBP0nNw2FKdgK+5YJFciFwTdORlZsdaTzjEbKN5ut+Ag4xGy69bbtXJmzkzRDHry9ubYbMW4xFMb
29823PJPyJ2xGmyB9oDHyNIUwNOt1dgpgolBwcE16ybaKD5q5eXIoHXNudlu+EaCcwXyLnryGdeBNfqofzLQe9f7s/iMVnsMZrbAPO/cYn6pTQEHVErYL080/hmZYV8faI89D
30422PJPyJ2xGmyB9oDHyNIUwNOt1dgpgolBwcE16ybaKD5pqVEGTBg/p+APpf4ALsiVmjdB8Qh1tgmKPCyx1kSOz7Hd9IsepYPj6a0odInh0gT5hycP6CbnVo7+9TxvjnCtS
info

📘 Alternativamente, você pode solicitar uma chave de API individual pelo suporte: [email protected].